Create a Tenant

This example demonstrates how to create a new tenant, user and roles in Pyramid, when using database authentication.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";

// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser1",
	"password":"abc123!"
},"",false);
log("got token "+token);

// step 2: create a new tenant to house new users
let createTenantResult = callApi("access/createTenant",{
	"name": "Test Tenant 1", //tenant caption
	"viewerSeats": 1, //number of allocated seats
	"proSeats": 1  //number of allocated seats
},token // admin token generated above
);

// step 3: get auto generated tenant ID from step 2 result.
let tenantId = createTenantResult.data.modifiedList[0].id;

log("created tenant, id= "+tenantId);


// step 4: create new user in new tenant. using DB method, because using local db authentication
let createUser = callApi("access/createUserDb",{
	"userName": "user1",
	"password": "1234",
	"firstName": "first",
	"lastName": "last",
	"email": "email@pyramidanalytics.com",
	"adminType": 0, //admin type enumeration: normal user
	"clientLicenseType": 100, //license type enumeration: viewer
	"tenantId": tenantId //tenant Id from previous step
},token // admin token generated above
);

// step 5: get auto generated user ID from step 4 result.
let userId = createUser.data.modifiedList[0].id;
log("created user "+userId);

//step 6: optional step to update user's first name
let updateUser=callApi("access/updateUsersDb",[{
	"id":userId,
	"firstName":"new first name"
}],token);

//step 7: create new role in tenant
let createRole=callApi("access/createRole",{
	"roleName": "new role",
	"isHidden": false, // hidden roles appear only in the admin - not for end users.
	"tenantId": tenantId
},token);

// step 8: get auto generated role ID from step 7 result.
let roleId = createRole.data.modifiedList[0].id;
log("created role "+roleId);

// step 9: associate user with role
let addUserToRole = callApi("access/addUserToRole",{
	"userId": userId,
	"roleId": roleId
},token);

log("addUserToRole was sucsseful since errorMessage is empty "+addUserToRole.data.errorMessage.length==0);


// ##### optional generic logging method for debugging ##############
function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

This example demonstrates how to find item's and the manipulation of content tags.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";


// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"abc123!"
},"",false);


//step 2: search for tenant by name
let tenant=callApi("access/getTenantByName","Company X",token);

let tenantId;

//step 3: if tenant is found, get its ID. Otherwise create the tenant
if(tenant.data != undefined){

    tenantId=tenant.data.id;
    log("found tenant with id "+ tenantId);
	
}else{

    log("tenant was not found ,creating one");
    let createTenantResult = callApi("access/createTenant",{
        "name": "Company X",
		"viewerSeats": 1,
		"proSeats": 1
    },token);
    tenantId = createTenantResult.data.modifiedList[0].id;
	
}


//step 4: delete the tenant we found in step 2
let deleteTenants=callApi("access/deleteTenants",{
	"tenantIds": [
		tenantId
	],
	"deleteUsers": true,
	"deleteServers": true
},token);

//step 5: get the default tenant
let defaultTenant = callApi("access/getDefaultTenant",{
  "auth": token
});

let defaultTenantId = defaultTenant.data;


//step 6: get available licenses by type for default tenant
let proSeatsNumber = callApi("access/getAvailableTenantLicenseCount",{
   "tenantId": defaultTenantId,
   "licenseType": 200,
},token);
log("The default tenant has "+ proSeatsNumber.data + " available pro seats licenses");

//step 7: get available users for tenant by license type
let proSeatsUsersData = callApi("access/getAllUsersDataByTenantAndLicenceType",{
  "tenantId": defaultTenantId,
  "clientLicenseType": 200,
},token);


// ##### optional generic logging method for debugging ##############
function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}